Interface PTPPortData

All Superinterfaces:
IPCObject
All Known Implementing Classes:
PTPPortDataImpl

public interface PTPPortData extends IPCObject
Information provided by the PKI file:

    \class PTPPortData
    \brief This file holds CPTPPortData class declaration.
    \example IpcBase::cast<SwitchPort>(network().getDevice("Switch0").getPort("FastEthernet0/1")).getPtpPortData();
    
Author:
Auto-generated
  • Method Details

    • setPtpVersion

      void setPtpVersion(int num)
      Information provided by the PKI file:
      
          \brief Sets ptp version.
          
          \param num, version number to use.
          
              
      Parameters:
      num - Takes in a parameter of num
    • getPtpVersion

      int getPtpVersion()
      Information provided by the PKI file:
      
          \brief Gets ptp version.
          
          \return int, version number.
          
              
      Returns:
      int Returns a int
    • setPortState

      void setPortState(PortState state)
      Information provided by the PKI file:
      
          \brief Sets the profile type.
          
          \param state, the port state to use.
          states:     eFaulty = 0,
          eInit = 1,
          eDisabled = 2,
          eListening = 3,
          eUncalibrated = 4,
          ePreMaster = 5,
          eSlave = 6,
          eMaster = 7,
          ePassive = 8
          
              
      Parameters:
      state - Takes in a parameter of state
    • getPortState

      PortState getPortState()
      Information provided by the PKI file:
      
          \brief Gets the port state.
          
          \return  PortState, the profile type.
          Port states:        eFaulty = 0,
          eInit = 1,
          eDisabled = 2,
          eListening = 3,
          eUncalibrated = 4,
          ePreMaster = 5,
          eSlave = 6,
          eMaster = 7,
          ePassive = 8
          
              
      Returns:
      PortState Returns a PortState
    • getPortStateStr

      String getPortStateStr()
      Information provided by the PKI file:
      
          \brief Returns the profile as a string.
          
          \return string,     profile strings:        "FAULTY",
          "INITIALIZING",
          "DISABLED",
          "LISTENING",
          "UNCALIBRATED",
          "PRE_MASTER",
          "SLAVE",
          "MASTER",
          "PASSIVE"
          
              
      Returns:
      String Returns a String
    • setRecommendedPortState

      void setRecommendedPortState(PortState state)
      Information provided by the PKI file:
      
          \brief Sets the recommended port state.
          
          \param state, the port state to use.
          states:     eFaulty = 0,
          eInit = 1,
          eDisabled = 2,
          eListening = 3,
          eUncalibrated = 4,
          ePreMaster = 5,
          eSlave = 6,
          eMaster = 7,
          ePassive = 8
          
              
      Parameters:
      state - Takes in a parameter of state
    • getRecommendedPortState

      PortState getRecommendedPortState()
      Information provided by the PKI file:
      
          \brief Gets the recommended port state.
          
          \return  PortState, the profile type.
          Port states:        eFaulty = 0,
          eInit = 1,
          eDisabled = 2,
          eListening = 3,
          eUncalibrated = 4,
          ePreMaster = 5,
          eSlave = 6,
          eMaster = 7,
          ePassive = 8
          
              
      Returns:
      PortState Returns a PortState
    • setDelayRequestInterval

      void setDelayRequestInterval(int num)
      Information provided by the PKI file:
      
          \brief Sets the delay request interval.
          
          \param num, the delay time in seconds
          
              
      Parameters:
      num - Takes in a parameter of num
    • getDelayRequestInterval

      int getDelayRequestInterval()
      Information provided by the PKI file:
      
          \brief Gets the delay request interval.
          
          \return int, the delay request interval time in seconds.
          
              
      Returns:
      int Returns a int
    • setAnnounceReceiptTimeout

      void setAnnounceReceiptTimeout(int num)
      Information provided by the PKI file:
      
          \brief Sets the announcement receipt timout time.
          
          \param num, the time.
          
              
      Parameters:
      num - Takes in a parameter of num
    • getAnnounceReceiptTimeout

      int getAnnounceReceiptTimeout()
      Information provided by the PKI file:
      
          \brief Gets the announcement receipt timout time.
          
          \return int, the announcement receipt timout time.
          
              
      Returns:
      int Returns a int
    • setAnnounceInterval

      void setAnnounceInterval(int num)
      Information provided by the PKI file:
      
          \brief Sets the announcement interval time.
          
          \param num, the time.
          
              
      Parameters:
      num - Takes in a parameter of num
    • getAnnounceInterval

      int getAnnounceInterval()
      Information provided by the PKI file:
      
          \brief Gets the announcement interval time.
          
          \return int, the announcement interval time.
          
              
      Returns:
      int Returns a int
    • setSyncInterval

      void setSyncInterval(int num)
      Information provided by the PKI file:
      
          \brief Sets the sync interval time.
          
          \param num, the time.
          
              
      Parameters:
      num - Takes in a parameter of num
    • getSyncInterval

      int getSyncInterval()
      Information provided by the PKI file:
      
          \brief Gets the sync interval time.
          
          \return int, the sync interval time.
          
              
      Returns:
      int Returns a int
    • setSyncWaitLimit

      void setSyncWaitLimit(long num)
      Information provided by the PKI file:
      
          \brief Sets the sync interval wait limit.
          
          \param num, the wait.
          
              
      Parameters:
      num - Takes in a parameter of num
    • getSyncWaitLimit

      int getSyncWaitLimit()
      Information provided by the PKI file:
      
          \brief Gets the sync interval wait limit.
          
          \return int, the sync interval wait limit.
          
              
      Returns:
      int Returns a int
    • setSyncMsgCounter

      void setSyncMsgCounter(int value)
      Information provided by the PKI file:
      
          \brief Sets the sync message counter.
          
          \param value, value to use.
          
              
      Parameters:
      value - Takes in a parameter of value
    • incrementSyncMsgCounter

      void incrementSyncMsgCounter()
      Information provided by the PKI file:
      
          \brief Increments the sync message counter.
          
              
    • getSyncMsgCounter

      int getSyncMsgCounter()
      Information provided by the PKI file:
      
          \brief Gets the sync message counter.
          
          \return int, value is the sync message count.
          
              
      Returns:
      int Returns a int
    • setDelayReqCounter

      void setDelayReqCounter(int num)
      Information provided by the PKI file:
      
          \brief Sets the delay request counter.
          
          \param num, value to use.
          
              
      Parameters:
      num - Takes in a parameter of num
    • incrementDelayReqCounter

      void incrementDelayReqCounter()
      Information provided by the PKI file:
      
          \brief Increments the delay request counter.
          
              
    • getDelayReqCounter

      int getDelayReqCounter()
      Information provided by the PKI file:
      
          \brief Gets delay request count.
          
          \return int, the delay request count.
          
              
      Returns:
      int Returns a int
    • setAnnounceSeqNum

      void setAnnounceSeqNum(double num)
      Information provided by the PKI file:
      
          \brief Sets the announce sequence number counter.
          
          \param num, value to use.
          
              
      Parameters:
      num - Takes in a parameter of num
    • getAnnounceSeqNum

      double getAnnounceSeqNum()
      Information provided by the PKI file:
      
          \brief Gets the announce sequence number.
          
          \return double, value is the announce sequence number.
          
              
      Returns:
      double Returns a double
    • setSyncSeqNum

      void setSyncSeqNum(double num)
      Information provided by the PKI file:
      
          \brief Sets the sync sequence number.
          
          \param num, value to use.
          
              
      Parameters:
      num - Takes in a parameter of num
    • getSyncSeqNum

      double getSyncSeqNum()
      Information provided by the PKI file:
      
          \brief Gets the sync sequence number.
          
          \return double, value is the sync message count.
          
              
      Returns:
      double Returns a double
    • setDecisionCode

      void setDecisionCode(DecisionCode code)
      Information provided by the PKI file:
      
          \brief Sets the decision code.
          
          \param code, the code to use.
          codes:      None = 0,
          M1 = 1,
          M2 = 2,
          M3 = 3,
          P1 = 4,
          P2 = 5,
          S1 = 6
          
              
      Parameters:
      code - Takes in a parameter of code
    • getDecisionCode

      DecisionCode getDecisionCode()
      Information provided by the PKI file:
      
          \brief Gets the recommended port state.
          
          \return  DecisionCode,      the profile type.
          Decision codes:             None = 0,
          M1 = 1,
          M2 = 2,
          M3 = 3,
          P1 = 4,
          P2 = 5,
          S1 = 6
          
              
      Returns:
      DecisionCode Returns a DecisionCode
    • setLastSyncSeqNum

      void setLastSyncSeqNum(double num)
      Information provided by the PKI file:
      
          \brief Sets the last sync sequence number.
          
          \param num, value to use.
          
              
      Parameters:
      num - Takes in a parameter of num
    • getLastSyncSeqNum

      double getLastSyncSeqNum()
      Information provided by the PKI file:
      
          \brief Gets the last sync sequence number.
          
          \return double, value is the last sync sequence number.
          
              
      Returns:
      double Returns a double
    • setLastGeneralEventSeqNum

      void setLastGeneralEventSeqNum(double num)
      Information provided by the PKI file:
      
          \brief Sets the last known general event sequence number.
          
          \param num, value to use.
          
              
      Parameters:
      num - Takes in a parameter of num
    • getLastGeneralEventSeqNum

      double getLastGeneralEventSeqNum()
      Information provided by the PKI file:
      
          \brief Gets the last general event sequence number.
          
          \return double, value is the last sync sequence number.
          
              
      Returns:
      double Returns a double
    • setBustEnabled

      void setBustEnabled(boolean enable)
      Information provided by the PKI file:
      
          \brief Sets bust to be enabled or disabled.
          
          \param enable, true to enable, false to disable.
          
              
      Parameters:
      enable - Takes in a parameter of enable
    • isBustEnabled

      boolean isBustEnabled()
      Information provided by the PKI file:
      
          \brief Gets bust enabled state.
          
          \return bool, returns true if bust is enabled, false if not.
          
              
      Returns:
      boolean Returns a boolean
    • removeForeignMasterBySrcPortId

      boolean removeForeignMasterBySrcPortId(String uuid, int portNum)
      Information provided by the PKI file:
      
          \brief Removes a foreign master by port.
          
          \param uuid, uuid to find for.
          \param portNum, port to find for.
          
          \return bool, value is true if the foreign master as removed, false if not.
          
              
      Parameters:
      uuid - Takes in a parameter of uuid
      portNum - Takes in a parameter of portNum
      Returns:
      boolean Returns a boolean
    • clearForeignMasterList

      void clearForeignMasterList()
      Information provided by the PKI file:
      
          \brief Removes all the foreign masters.
          
              
    • setEBestSrc

      void setEBestSrc(boolean value)
      Information provided by the PKI file:
      
          \brief Sets the port data to be or not to be the best source for grandmaster clock
          
          \param value, true if the port data is the best source for grandmaster clock and false otherwise.
          
              
      Parameters:
      value - Takes in a parameter of value
    • isEBestSrc

      boolean isEBestSrc()
      Information provided by the PKI file:
      
          \brief Check if this port data is the best source for grandmaster clock
          
          \return value, true if it is and false otherwise.
          
              
      Returns:
      boolean Returns a boolean
    • resetDatasetToDefault

      void resetDatasetToDefault()
      Information provided by the PKI file:
      
          \brief Resets the data set to default.
          
              
    • cancelTimer

      void cancelTimer()
      Information provided by the PKI file:
      
          \brief Cancels the timer.
          
              
    • clearConfig

      void clearConfig()
      Information provided by the PKI file:
      
          \brief Clears the config.